<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Gets line from file and parse as CSV fields</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="splfileobject.fgetc.html">SplFileObject::fgetc</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="splfileobject.fgets.html">SplFileObject::fgets</a></div>
 <div class="up"><a href="class.splfileobject.html">SplFileObject</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="splfileobject.fgetcsv" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">SplFileObject::fgetcsv</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.1.0)</p><p class="refpurpose"><span class="refname">SplFileObject::fgetcsv</span> &mdash; <span class="dc-title">Gets line from file and parse as CSV fields</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-splfileobject.fgetcsv-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>SplFileObject::fgetcsv</strong></span>
    ([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$delimiter</code><span class="initializer"> = &quot;,&quot;</span></span>
   [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$enclosure</code><span class="initializer"> = &quot;\&quot;&quot;</span></span>
   [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$escape</code><span class="initializer"> = &quot;\\&quot;</span></span>
  ]]] )</div>

  <p class="para rdfs-comment">
   Gets a line from the file which is in <acronym title="Comma Separated Value">CSV</acronym> format and returns an array containing the fields read.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-splfileobject.fgetcsv-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>

    
     <dt>
<em><code class="parameter">delimiter</code></em></dt>

     <dd>

      <p class="para">
       The field delimiter (one character only). Defaults as a comma or the value set using <span class="methodname"><a href="splfileobject.setcsvcontrol.html" class="methodname">SplFileObject::setCsvControl()</a></span>.
      </p>
     </dd>

    
    
     <dt>
<em><code class="parameter">enclosure</code></em></dt>

     <dd>

      <p class="para">
       The field enclosure character (one character only). Defaults as a double quotation mark or the value set using <span class="methodname"><a href="splfileobject.setcsvcontrol.html" class="methodname">SplFileObject::setCsvControl()</a></span>.
      </p>
     </dd>

    
    
     <dt>
<em><code class="parameter">escape</code></em></dt>

     <dd>

      <p class="para">
       The escape character (one character only). Defaults as a backslash (<em>\</em>) or the value set using <span class="methodname"><a href="splfileobject.setcsvcontrol.html" class="methodname">SplFileObject::setCsvControl()</a></span>.
      </p>
     </dd>

    
   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-splfileobject.fgetcsv-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   Returns an indexed array containing the fields read, or <strong><code>FALSE</code></strong> on error.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    A blank line in a CSV file will be returned as an array
    comprising a single <strong><code>NULL</code></strong> field unless using <strong><code>SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE</code></strong>, 
    in which case empty lines are skipped.
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 examples" id="refsect1-splfileobject.fgetcsv-examples">
  <h3 class="title">范例</h3>
  <p class="para">
   <div class="example" id="example-3857">
    <p><strong>Example #1 <span class="methodname"><strong>SplFileObject::fgetcsv()</strong></span> example</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$file&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">SplFileObject</span><span style="color: #007700">(</span><span style="color: #DD0000">"data.csv"</span><span style="color: #007700">);<br />while&nbsp;(!</span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">eof</span><span style="color: #007700">())&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">fgetcsv</span><span style="color: #007700">());<br />}<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
    </div>

   </div>
  </p>
  <p class="para">
   <div class="example" id="example-3858">
    <p><strong>Example #2 <strong><code>SplFileObject::READ_CSV</code></strong> example</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$file&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">SplFileObject</span><span style="color: #007700">(</span><span style="color: #DD0000">"animals.csv"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setFlags</span><span style="color: #007700">(</span><span style="color: #0000BB">SplFileObject</span><span style="color: #007700">::</span><span style="color: #0000BB">READ_CSV</span><span style="color: #007700">);<br />foreach&nbsp;(</span><span style="color: #0000BB">$file&nbsp;</span><span style="color: #007700">as&nbsp;</span><span style="color: #0000BB">$row</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;list(</span><span style="color: #0000BB">$animal</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$class</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$legs</span><span style="color: #007700">)&nbsp;=&nbsp;</span><span style="color: #0000BB">$row</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"A&nbsp;%s&nbsp;is&nbsp;a&nbsp;%s&nbsp;with&nbsp;%d&nbsp;legs\n"</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$animal</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$class</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">$legs</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
    </div>

    <div class="example-contents"><p>Contents of animals.csv</p></div>
    <div class="example-contents">
<div class="txtcode"><pre class="txtcode">crocodile,reptile,4
dolphin,mammal,0
duck,bird,2
koala,mammal,4
salmon,fish,0</pre>
</div>
    </div>

    <div class="example-contents"><p>以上例程的输出类似于：</p></div>
    <div class="example-contents screen">
<div class="cdata"><pre>
A crocodile is a reptile with 4 legs
A dolphin is a mammal with 0 legs
A duck is a bird with 2 legs
A koala is a mammal with 4 legs
A salmon is a fish with 0 legs
</pre></div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-splfileobject.fgetcsv-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><span class="methodname"><a href="splfileobject.setcsvcontrol.html" class="methodname" rel="rdfs-seeAlso">SplFileObject::setCsvControl()</a> - Set the delimiter and enclosure character for CSV</span></li>
    <li class="member"><span class="methodname"><a href="splfileobject.setflags.html" class="methodname" rel="rdfs-seeAlso">SplFileObject::setFlags()</a> - Sets flags for the SplFileObject</span></li>
    <li class="member"><a href="class.splfileobject.html#splfileobject.constants.read-csv" class="link">SplFileObject::READ_CSV</a></li>
    <li class="member"><span class="methodname"><a href="splfileobject.current.html" class="methodname" rel="rdfs-seeAlso">SplFileObject::current()</a> - Retrieve current line of file</span></li>
   </ul>
  </p>
 </div>


</div><hr /><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="splfileobject.fgetc.html">SplFileObject::fgetc</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="splfileobject.fgets.html">SplFileObject::fgets</a></div>
 <div class="up"><a href="class.splfileobject.html">SplFileObject</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
